refactor: rename package to @mcpdotdirect/template-mcp-server and upd… - #1
Conversation
…ate README for user quickstart
WalkthroughThis pull request updates project metadata and introduces a new script. The README now reflects the new project name and a revised description, along with a minor rephrasing of the usage instructions. A new Node.js script ( Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Script
participant FileSystem
User->>Script: Execute "create-mcp-server" command
Script->>FileSystem: Check if current directory is empty
alt Directory not empty
FileSystem-->>Script: Return directory contents
Script->>User: Prompt to create a new directory
else Directory empty
Script->>FileSystem: Validate source directory exists
FileSystem-->>Script: Confirm existence or error if missing
Script->>FileSystem: Copy relevant files (skipping node_modules, etc.)
FileSystem-->>Script: Files copied
Script->>User: Generate package.json and display next steps
end
Poem
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
bin/create-mcp-server.js (1)
145-186: Consider allowing customization of the generated project.The function creates a fixed package.json with hardcoded values. Consider enhancing user experience by allowing some customization.
You could:
- Allow specifying a custom project name
- Optionally include repository details
- Let users select which dependencies to include
Example implementation:
-function createProjectPackageJson() { +function createProjectPackageJson(options = {}) { const packageJsonPath = path.join(targetDir, 'package.json'); + const projectName = options.projectName || path.basename(targetDir); const projectPackageJson = { - name: "mcp-server", + name: projectName, module: "src/index.ts", type: "module", version: "1.0.0", description: "Model Context Protocol (MCP) Server", private: true, // rest of the configuration... }; // Write the file... }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(1 hunks)bin/create-mcp-server.js(1 hunks)package.json(2 hunks)
🔇 Additional comments (5)
README.md (1)
1-1: The project name and description have been updated successfully.The package renaming from
@mcpdotdirect/create-mcp-serverto@mcpdotdirect/template-mcp-serverand the more concise description are good improvements that clarify the purpose of this package.Also applies to: 7-7
package.json (4)
2-11: Good package configuration for CLI tool.The package is properly configured with:
- Correct scoped name
- Public access
- Main entry point
- Bin configuration for the CLI tool
- Appropriate files array
This setup will ensure the package works correctly when published and installed.
27-29: Appropriate build script for publishing.Adding the
prepublishOnlyscript ensures the package is built before publishing, which is a good practice.
30-54: Complete metadata for package visibility.The repository, keywords, author, license, bugs, and homepage fields are well configured, which improves discoverability and provides important information for users.
70-72: Good practice: Node.js version requirement.Specifying the minimum Node.js version required ensures users have a compatible environment to run your package.
1 participant
…ate README for user quickstart
Summary by CodeRabbit
New Features
Documentation
Chores